MarkLogic 10 Product Documentation
GET /manage/v2/protected-paths/{id|name}

Summary

This resource endpoint retrieves a given protected path.

URL Parameters
fullrefs If set to true, full detail is returned for all relationship references. A value of false (the default) indicates to return detail only for first references. This is only applicable for view=status.
view A specific view of the returned data. Can be either schema, status, metrics, query, or default. Value can be describe or default.
format The format of the returned data. Can be either html, json, or xml (default). This value overrides the Accept header if both are present. Value can be xml, json or html.
Request Headers
Accept The expected MIME type of the request body. If the format parameter is present, it takes precedence over the Accept header.
Response Headers
Content-type ] The MIME type of the data in the response body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.

Response

A successful call to the endpoint will return the HTTP code 200 OK. This is the standard response for successful HTTP requests. The actual response will depend on the request method used.

Produces
application/xml XML Content
application/json JSON Content
text/html HTML Web Content

Required Privileges

This operation requires the manage-user role, or the following privilege:

http://marklogic.com/xdmp/privileges/manage

Usage Notes

This resource endpoint retrieves a given protected path.

The structure of the output returned from this REST API is as follows:

protected-path

meta

Properties of the view rather than the resource.

This is a complex structure with the following children:

uri

The path to the view.

current-time

The timestamp for when the view was generated.

elapsed-time

The time required to construct the view. The elapsed time indicates the relative cost of generating the view. Consider the cost when determining how frequently to request a view.

start-min

The timestamp for filtering out more recent requests or transactions.

view-error

An error limiting the data in the view.

This is a complex structure with the following children:

error-type

The kind of error.

error-name

The name of the error.

error-code

The error identifier.

error-message

The error text.

relations

Relationships to resources.

This is a complex structure with the following children:

relation-group

Related resources with the same type.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

relation-count

The number of related resources.

relation

A specific related resource.

This is a complex structure with the following children:

qualifiers

A list of associated resources that distinguish the resource.

This is a complex structure with the following children:

qualifier

Another resource that qualifies the resource.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

uriref

The path for a resource or list of resources.

typeref

The type of a resource or list of resources.

roleref

A role that distinguishes the resource.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

related-views

A list of broader or narrower views on the resource or resource type.

This is a complex structure with the following children:

related-view

A broader or narrower view on the resource or resource type.

This is a complex structure with the following children:

view-type

The kind of view.

view-name

The name of the view.

view-uri

The path for the view.

Example

> curl -X GET --anyauth -u admin:admin 
            -H "Content-Type:application/xml"  http://localhost:8002/manage/v2/protected-paths/

Output:

<?xml version="1.0" encoding="UTF-8"?>
<protected-path-default-list xsi:schemaLocation="http://marklogic.com/manage/security manage-security.xsd" xmlns="http://marklogic.com/manage/security" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <meta>
    <uri>/manage/v2/protected-paths/</uri>
    <current-time>2017-05-02T02:05:22.1043833-07:00</current-time>
    <elapsed-time units="sec">0.010264</elapsed-time>
  </meta>
  <list-items>
    <list-count units="quantity">0</list-count>
  </list-items>
  <relations>
    <relation-group array="true">
      <typeref>security-database</typeref>
      <relation-count units="quantity">1</relation-count>
      <relation array="true">
	<uriref>/manage/v2/databases/Security</uriref>
	<roleref>database</roleref>
	<idref>7161534863501463199</idref>
      </relation>
    </relation-group>
  </relations>
</protected-path-default-list>

This is the XML output for GET.

Example

>
             curl -X GET --anyauth -u admin:admin \
            -H "Content-Type:application/json" \ 
             http://localhost:8002/manage/v2/protected-paths//11247920484610845208

Output:

	{
		"protected-path-default-list":{
			"meta":{
				"uri":"/manage/v2/protected-paths/",
				"current-time":"2017-05-02T02:05:22.1039234-07:00",
				"elapsed-time":{
					"units":"sec",
					"value":0.0107508}
				}
			,
			"list-items":{
				"list-count":{
					"units":"quantity",
					"value":0}
				}
			,
			"relations":{
				"relation-group":{
					"typeref":"security-database",
					"relation-count":{
						"units":"quantity",
						"value":1}
					,
					"relation":{
						"uriref":"/manage/v2/databases/Security",
						"roleref":"database",
						"idref":"7161534863501463199",
						"nameref":"Security"}
					}
				}
			,
			"related-views":{
				"related-view":[
					{
						"view-type":"root",
						"view-name":"default",
						"view-uri":"/manage/v2"}
					]
				}
			}
		}

This is the JSON output for GET.

Powered by MarkLogic Server | Terms of Use | Privacy Policy